2 # MediaWiki web-based config/installation
3 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
4 # http://www.mediawiki.org/
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with this program; if not, write to the Free Software Foundation, Inc.,
18 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 # http://www.gnu.org/copyleft/gpl.html
21 error_reporting( E_ALL
);
22 header( "Content-type: text/html; charset=utf-8" );
23 @ini_set
( "display_errors", true );
25 ?
><!DOCTYPE HTML
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
26 "http://www.w3.org/TR/html4/loose.dtd">
29 <meta http
-equiv
="Content-type" content
="text/html; charset=utf-8">
30 <meta name
="robots" content
="noindex,nofollow">
31 <title
>MediaWiki installation
</title
>
32 <style type
="text/css">
37 background
-color
: #eee;
39 border
: solid
1px
#444;
47 dl
.setup dd label
.column
{
59 /* margin-right: 200px; */
77 <a href
="http://www.mediawiki.org/">
78 <img src
="../skins/common/images/mediawiki.png" width
="135" height
="135" alt
="" border
="0" />
82 <p
><strong
><a href
="http://www.mediawiki.org/">MediaWiki
</a
></strong
> is
83 Copyright (C
) 2001-2005 by Magnus Manske
, Brion Vibber
, Lee Daniel Crocker
,
84 Tim Starling
, Erik M
ö
;ller
, Gabriel Wicke
and others
.</p
>
87 <li
><a href
="../README">Readme
</a
></li
>
88 <li
><a href
="../RELEASE-NOTES">Release notes
</a
></li
>
89 <li
><a href
="../docs/">doc
/</a
></li
>
90 <li
><a href
="http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide">User
's Guide</a></li>
93 <p>This program is free software; you can redistribute it and/or modify
94 it under the terms of the GNU General Public License as published by
95 the Free Software Foundation; either version 2 of the License, or
96 (at your option) any later version.</p>
98 <p>This program is distributed in the hope that it will be useful,
99 but WITHOUT ANY WARRANTY; without even the implied warranty of
100 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
101 GNU General Public License for more details.</p>
103 <p>You should have received <a href="../COPYING">a copy of the GNU General Public License</a>
104 along with this program; if not, write to the Free Software
105 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
106 or <a href="http://www.gnu.org/copyleft/gpl.html">read it online</a></p>
111 # Relative includes seem to break if a parent directory is not readable;
112 # this is common for public_html subdirs under user home directories.
114 # As a dirty hack, we'll
try to set up the
include path first
.
116 $IP = dirname( dirname( __FILE__
) );
117 $sep = (DIRECTORY_SEPARATOR
== "\\") ?
";" : ":";
118 ini_set( "include_path", ".$sep$IP$sep$IP/includes$sep$IP/languages" );
120 define( "MEDIAWIKI", true );
121 define( "MEDIAWIKI_INSTALL", true );
122 require_once( "includes/Defines.php" );
123 require_once( "includes/DefaultSettings.php" );
124 require_once( "includes/MagicWord.php" );
125 require_once( "includes/Namespace.php" );
128 <h1
>MediaWiki
<?php
print $wgVersion ?
> installation
</h1
>
133 /* Check for existing configurations and bug out! */
135 if( file_exists( "../LocalSettings.php" ) ) {
136 dieout( "<h2>Wiki is configured.</h2>
138 <p>Already configured... <a href='../index.php'>return to the wiki</a>.</p>
140 <p>(You should probably remove this directory for added security.)</p>" );
143 if( file_exists( "./LocalSettings.php" ) ) {
144 writeSuccessMessage();
149 if( !is_writable( "." ) ) {
150 dieout( "<h2>Can't write config file, aborting</h2>
152 <p>In order to configure the wiki you have to make the <tt>config</tt> subdirectory
153 writable by the web server. Once configuration is done you'll move the created
154 <tt>LocalSettings.php</tt> to the parent directory, and for added safety you can
155 then remove the <tt>config</tt> subdirectory entirely.</p>
157 <p>To make the directory writable on a Unix/Linux system:</p>
160 cd <i>/path/to/wiki</i>
166 require_once( "install-utils.inc" );
167 require_once( "maintenance/updaters.inc" );
170 function getEncoded( $data ) {
171 # removing latin1 support, no need...
174 function getSitename() { return $this->getEncoded( $this->Sitename
); }
175 function getSysopName() { return $this->getEncoded( $this->SysopName
); }
176 function getSysopPass() { return $this->getEncoded( $this->SysopPass
); }
181 <p
><em
>Please
include all of the lines below when reporting installation problems
.</em
></p
>
183 <h2
>Checking environment
...</h2
>
188 $wgNoOutputBuffer = true;
189 $conf = new ConfigData
;
191 install_version_checks();
193 print "<li>PHP " . phpversion() . ": ok</li>\n";
195 if( ini_get( "register_globals" ) ) {
197 <li
><b
class='error'>Warning
:</b
> <strong
>PHP
's
198 <tt><a href="http://php.net/register_globals">register_globals</a></tt>
199 option is enabled.</strong> MediaWiki will work correctly, but this setting
200 increases your exposure to potential security vulnerabilities in PHP-based
201 software running on your server. <strong>You should disable it if you are able.</strong></li>
207 if( ini_get( "magic_quotes_runtime" ) ) {
209 ?><li class='error
'><strong>Fatal: <a href='http
://www.php.net/manual/en/ref.info.php#ini.magic-quotes-runtime'>magic_quotes_runtime</a> is active!</strong>
210 This option corrupts data input unpredictably
; you cannot install
or use
211 MediaWiki unless this option is disabled
.
215 if( ini_get( "magic_quotes_sybase" ) ) {
217 ?
><li
class='error'><strong
>Fatal
: <a href
='http://www.php.net/manual/en/ref.sybase.php#ini.magic-quotes-sybase'>magic_quotes_sybase
</a
> is active
!</strong
>
218 This option corrupts data input unpredictably
; you cannot install
or use
219 MediaWiki unless this option is disabled
.
224 dieout( "</ul><p>Cannot install wiki.</p>" );
227 if( ini_get( "safe_mode" ) ) {
228 $conf->safeMode
= true;
230 <li
><b
class='error'>Warning
:</b
> <strong
>PHP
's
231 <a href='http
://www.php.net/features.safe-mode'>safe mode</a> is active.</strong>
232 You may have problems caused by this
, particularly
if using image uploads
.
236 $conf->safeMode
= false;
240 $sapi = php_sapi_name();
241 $conf->prettyURLs
= true;
242 print "<li>PHP server API is $sapi; ";
245 case "apache2handler":
246 print "ok, using pretty URLs (<tt>index.php/Page_Title</tt>)";
250 case "apache2filter":
251 print "using ugly URLs (<tt>index.php?title=Page_Title</tt>)";
252 $conf->prettyURLs
= false;
255 print "unknown; using pretty URLs (<tt>index.php/Page_Title</tt>), if you have trouble change this in <tt>LocalSettings.php</tt>";
259 $conf->xml
= function_exists( "utf8_encode" );
261 print "<li>Have XML / Latin1-UTF-8 conversion support.</li>\n";
263 dieout( "PHP's XML module is missing; the wiki requires functions in
264 this module and won't work in this configuration.
265 If you're running Mandrake, install the php-xml package." );
268 $memlimit = ini_get( "memory_limit" );
269 $conf->raiseMemory
= false;
270 if( empty( $memlimit ) ||
$memlimit == -1 ) {
271 print "<li>PHP is configured with no <tt>memory_limit</tt>.</li>\n";
273 print "<li>PHP's <tt>memory_limit</tt> is " . htmlspecialchars( $memlimit ) . ". <strong>If this is too low, installation may fail!</strong> ";
274 $n = intval( $memlimit );
275 if( preg_match( '/^([0-9]+)[Mm]$/', trim( $memlimit ), $m ) ) {
276 $n = intval( $m[1] * (1024*1024) );
278 if( $n < 20*1024*1024 ) {
279 print "Attempting to raise limit to 20M... ";
280 if( false === ini_set( "memory_limit", "20M" ) ) {
283 $conf->raiseMemory
= true;
290 $conf->zlib
= function_exists( "gzencode" );
292 print "<li>Have zlib support; enabling output compression.</li>\n";
294 print "<li>No zlib support.</li>\n";
297 $conf->turck
= function_exists( 'mmcache_get' );
298 if ( $conf->turck
) {
299 print "<li><a href=\"http://turck-mmcache.sourceforge.net/\">Turck MMCache</a> installed</li>\n";
301 $conf->eaccel
= function_exists( 'eaccelerator_get' );
302 if ( $conf->eaccel
) {
303 $conf->turck
= 'eaccelerator';
304 print "<li><a href=\"http://eaccelerator.sourceforge.net/\">eAccelerator</a> installed</li>\n";
306 if (!$conf->turck
&& !$conf->eaccel
) {
307 print "<li>Neither <a href=\"http://turck-mmcache.sourceforge.net/\">Turck MMCache</a> nor <a href=\"http://eaccelerator.sourceforge.net/\">eAccelerator</a> are installed, " .
308 "can't use object caching functions</li>\n";
311 $conf->diff3
= false;
312 $diff3locations = array("/usr/bin", "/opt/csw/bin", "/usr/gnu/bin", "/usr/sfw/bin") +
explode(":", getenv("PATH"));
313 $diff3names = array("gdiff3", "diff3");
315 $diff3versioninfo = array('$1 --version 2>&1', 'diff3 (GNU diffutils)');
316 foreach ($diff3locations as $loc) {
317 $exe = locate_executable($loc, $diff3names, $diff3versioninfo);
318 if ($exe !== false) {
325 print "<li>Found GNU diff3: <tt>$conf->diff3</tt>.</li>";
327 print "<li>GNU diff3 not found.</li>";
329 $conf->ImageMagick
= false;
330 $imcheck = array( "/usr/bin", "/usr/local/bin", "/sw/bin", "/opt/local/bin" );
331 foreach( $imcheck as $dir ) {
332 $im = "$dir/convert";
333 if( file_exists( $im ) ) {
334 print "<li>Found ImageMagick: <tt>$im</tt>; image thumbnailing will be enabled if you enable uploads.</li>\n";
335 $conf->ImageMagick
= $im;
340 $conf->HaveGD
= function_exists( "imagejpeg" );
341 if( $conf->HaveGD
) {
342 print "<li>Found GD graphics library built-in";
343 if( !$conf->ImageMagick
) {
344 print ", image thumbnailing will be enabled if you enable uploads";
348 if( !$conf->ImageMagick
) {
349 print "<li>Couldn't find GD library or ImageMagick; image thumbnailing disabled.</li>\n";
353 $conf->UseImageResize
= $conf->HaveGD ||
$conf->ImageMagick
;
355 # $conf->IP = "/Users/brion/Sites/inplace";
356 $conf->IP
= dirname( dirname( __FILE__
) );
357 print "<li>Installation directory: <tt>" . htmlspecialchars( $conf->IP
) . "</tt></li>\n";
359 # $conf->ScriptPath = "/~brion/inplace";
360 $conf->ScriptPath
= preg_replace( '{^(.*)/config.*$}', '$1', $_SERVER["PHP_SELF"] ); # was SCRIPT_NAME
361 print "<li>Script URI path: <tt>" . htmlspecialchars( $conf->ScriptPath
) . "</tt></li>\n";
363 $conf->posted
= ($_SERVER["REQUEST_METHOD"] == "POST");
365 $conf->Sitename
= ucfirst( importPost( "Sitename", "" ) );
366 $defaultEmail = empty( $_SERVER["SERVER_ADMIN"] )
368 : $_SERVER["SERVER_ADMIN"];
369 $conf->EmergencyContact
= importPost( "EmergencyContact", $defaultEmail );
370 $conf->DBtype
= importPost( "DBtype", "mysql" );
371 $conf->DBserver
= importPost( "DBserver", "localhost" );
372 $conf->DBname
= importPost( "DBname", "wikidb" );
373 $conf->DBuser
= importPost( "DBuser", "wikiuser" );
374 $conf->DBpassword
= importPost( "DBpassword" );
375 $conf->DBpassword2
= importPost( "DBpassword2" );
376 $conf->DBprefix
= importPost( "DBprefix" );
377 $conf->RootPW
= importPost( "RootPW" );
378 $conf->LanguageCode
= importPost( "LanguageCode", "en" );
379 $conf->SysopName
= importPost( "SysopName", "WikiSysop" );
380 $conf->SysopPass
= importPost( "SysopPass" );
381 $conf->SysopPass2
= importPost( "SysopPass2" );
383 /* Check for validity */
386 if( $conf->Sitename
== "" ||
$conf->Sitename
== "MediaWiki" ||
$conf->Sitename
== "Mediawiki" ) {
387 $errs["Sitename"] = "Must not be blank or \"MediaWiki\".";
389 if( $conf->DBuser
== "" ) {
390 $errs["DBuser"] = "Must not be blank";
392 if( $conf->DBpassword
== "" ) {
393 $errs["DBpassword"] = "Must not be blank";
395 if( $conf->DBpassword
!= $conf->DBpassword2
) {
396 $errs["DBpassword2"] = "Passwords don't match!";
398 if( !preg_match( '/^[A-Za-z_0-9]*$/', $conf->DBprefix
) ) {
399 $errs["DBprefix"] = "Invalid table prefix";
402 if( $conf->SysopPass
== "" ) {
403 $errs["SysopPass"] = "Must not be blank";
405 if( $conf->SysopPass
!= $conf->SysopPass2
) {
406 $errs["SysopPass2"] = "Passwords don't match!";
409 $conf->License
= importRequest( "License", "none" );
410 if( $conf->License
== "gfdl" ) {
411 $conf->RightsUrl
= "http://www.gnu.org/copyleft/fdl.html";
412 $conf->RightsText
= "GNU Free Documentation License 1.2";
413 $conf->RightsCode
= "gfdl";
414 $conf->RightsIcon
= '${wgStylePath}/common/images/gnu-fdl.png';
415 } elseif( $conf->License
== "none" ) {
416 $conf->RightsUrl
= $conf->RightsText
= $conf->RightsCode
= $conf->RightsIcon
= "";
418 $conf->RightsUrl
= importRequest( "RightsUrl", "" );
419 $conf->RightsText
= importRequest( "RightsText", "" );
420 $conf->RightsCode
= importRequest( "RightsCode", "" );
421 $conf->RightsIcon
= importRequest( "RightsIcon", "" );
424 $conf->Shm
= importRequest( "Shm", "none" );
425 $conf->MCServers
= importRequest( "MCServers" );
427 /* Test memcached servers */
429 if ( $conf->Shm
== 'memcached' && $conf->MCServers
) {
430 $conf->MCServerArray
= array_map( 'trim', explode( ',', $conf->MCServers
) );
431 foreach ( $conf->MCServerArray
as $server ) {
432 $error = testMemcachedServer( $server );
434 $errs["MCServers"] = $error;
438 } else if ( $conf->Shm
== 'memcached' ) {
439 $errs["MCServers"] = "Please specify at least one server if you wish to use memcached";
442 /* default values for installation */
443 $conf->Email
=importRequest("Email", "email_enabled");
444 $conf->Emailuser
=importRequest("Emailuser", "emailuser_enabled");
445 $conf->Enotif
=importRequest("Enotif", "enotif_allpages");
446 $conf->Eauthent
=importRequest("Eauthent", "eauthent_enabled");
448 if( $conf->posted
&& ( 0 == count( $errs ) ) ) {
449 do { /* So we can 'continue' to end prematurely */
450 $conf->Root
= ($conf->RootPW
!= "");
452 /* Load up the settings and get installin' */
453 $local = writeLocalSettings( $conf );
454 $wgCommandLineMode = false;
457 if (!in_array($conf->DBtype
, array("mysql", "oracle"))) {
458 $errs["DBtype"] = "Unknown database type.";
461 print "<li>Database type: {$conf->DBtype}</li>\n";
462 $dbclass = 'Database'.ucfirst($conf->DBtype
);
463 require_once("$dbclass.php");
464 $wgDBtype = $conf->DBtype
;
465 $wgDBadminuser = "root";
466 $wgDBadminpassword = $conf->RootPW
;
467 $wgDBprefix = $conf->DBprefix
;
468 $wgCommandLineMode = true;
469 $wgUseDatabaseMessages = false; /* FIXME: For database failure */
470 require_once( "includes/Setup.php" );
473 require_once( "maintenance/InitialiseMessages.inc" );
475 $wgTitle = Title
::newFromText( "Installation script" );
476 $mysqlOldClient = version_compare( mysql_get_client_info(), "4.1.0", "lt" );
477 if( $mysqlOldClient ) {
478 print "<li><b>PHP is linked with old MySQL client libraries. If you are
479 using a MySQL 4.1 server and have problems connecting to the database,
480 see <a href='http://dev.mysql.com/doc/mysql/en/old-client.html'
481 >http://dev.mysql.com/doc/mysql/en/old-client.html</a> for help.</b></li>\n";
484 if ($conf->DBtype
== 'mysql') {
485 print "<li>Trying to connect to database server on $wgDBserver as root...\n";
486 $wgDatabase = $dbc->newFromParams( $wgDBserver, "root", $conf->RootPW
, "", 1 );
488 if( $wgDatabase->isOpen() ) {
489 $myver = get_db_version();
490 $wgDatabase->ignoreErrors(true);
492 print "<ul><li>Connected as root (automatic)</li></ul></li>\n";
494 print "<ul><li>MySQL error " . ($err = mysql_errno() ) .
495 ": " . htmlspecialchars( mysql_error() ) . "</li></ul></li>";
501 $errs["RootPW"] = "Check password";
503 print "<li>Trying regular user...\n";
504 /* Try the regular user... */
505 $wgDBadminuser = $wgDBuser;
506 $wgDBadminpassword = $wgDBpassword;
507 /* Wait one second for connection rate limiting, present on some systems */
509 $wgDatabase = Database
::newFromParams( $wgDBserver, $wgDBuser, $wgDBpassword, "", 1 );
510 if( !$wgDatabase->isOpen() ) {
511 print "<ul><li>MySQL error " . ($err = mysql_errno() ) .
512 ": " . htmlspecialchars( mysql_error() ) . "</li></ul></li>";
513 $errs["DBuser"] = "Check name/pass";
514 $errs["DBpassword"] = "or enter root";
515 $errs["DBpassword2"] = "password below";
516 $errs["RootPW"] = "Got root?";
518 $myver = mysql_get_server_info( $wgDatabase->mConn
);
519 $wgDatabase->ignoreErrors(true);
530 $errs["DBserver"] = "Connection failed";
533 $errs["DBserver"] = "Couldn't connect to database";
538 } else /* not mysql */ {
539 print "<li>Connecting to SQL server...";
540 $wgDatabase = $dbc->newFromParams($wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, 1);
541 if (!$wgDatabase->isOpen()) {
542 print " error: " . $wgDatabase->lastError() . "</li>\n";
544 $wgDatabase->ignoreErrors(true);
545 $myver = get_db_version();
549 if ( !$wgDatabase->isOpen() ) {
550 $errs["DBserver"] = "Couldn't connect to database";
554 print "<li>Connected to $myver";
555 if( version_compare( $myver, "4.0.0" ) < 0 ) {
556 die( " -- mysql 4.0 or later required. Aborting." );
558 $mysqlNewAuth = version_compare( $myver, "4.1.0", "ge" );
559 if( $mysqlNewAuth && $mysqlOldClient ) {
560 print "; <b class='error'>You are using MySQL 4.1 server, but PHP is linked
561 to old client libraries; if you have trouble with authentication, see
562 <a href='http://dev.mysql.com/doc/mysql/en/old-client.html'
563 >http://dev.mysql.com/doc/mysql/en/old-client.html</a> for help.</b>";
567 if ($conf->DBtype
== 'mysql') {
568 @$sel = mysql_select_db( $wgDBname, $wgDatabase->mConn
);
570 print "<li>Database <tt>" . htmlspecialchars( $wgDBname ) . "</tt> exists</li>\n";
572 $err = mysql_errno();
573 if ( $err != 1049 ) {
574 print "<ul><li>Error selecting database $wgDBname: $err " .
575 htmlspecialchars( mysql_error() ) . "</li></ul>";
578 $res = $wgDatabase->query( "CREATE DATABASE `$wgDBname`" );
580 print "<li>Couldn't create database <tt>" .
581 htmlspecialchars( $wgDBname ) .
582 "</tt>; try with root access or check your username/pass.</li>\n";
583 $errs["RootPW"] = "<- Enter";
586 print "<li>Created database <tt>" . htmlspecialchars( $wgDBname ) . "</tt></li>\n";
588 $wgDatabase->selectDB( $wgDBname );
592 if( $wgDatabase->tableExists( "cur" ) ||
$wgDatabase->tableExists( "revision" ) ) {
593 print "<li>There are already MediaWiki tables in this database. Checking if updates are needed...</li>\n";
595 # Create user if required
597 $conn = Database
::newFromParams( $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, 1 );
598 if ( $conn->isOpen() ) {
599 print "<li>DB user account ok</li>\n";
602 print "<li>Granting user permissions...";
603 if( $mysqlOldClient && $mysqlNewAuth ) {
604 print " <b class='error'>If the next step fails, see <a href='http://dev.mysql.com/doc/mysql/en/old-client.html'>http://dev.mysql.com/doc/mysql/en/old-client.html</a> for help.</b>";
607 dbsource( "../maintenance/users.sql", $wgDatabase );
617 print "<li>Finished update checks.</li>\n";
619 # FIXME: Check for errors
620 print "<li>Creating tables...";
621 if ($conf->DBtype
== 'mysql') {
622 dbsource( "../maintenance/tables.sql", $wgDatabase );
623 dbsource( "../maintenance/interwiki.sql", $wgDatabase );
625 dbsource( "../maintenance/oracle/tables.sql", $wgDatabase );
626 dbsource( "../maintenance/oracle/interwiki.sql", $wgDatabase );
629 print " done.</li>\n";
631 print "<li>Initializing data...";
632 $wgDatabase->insert( 'site_stats',
633 array( 'ss_row_id' => 1,
634 'ss_total_views' => 0,
635 'ss_total_edits' => 0,
636 'ss_good_articles' => 0 ) );
637 # setting up the db user
639 print "<li>Granting user permissions...</li>\n";
640 dbsource( "../maintenance/users.sql", $wgDatabase );
643 if( $conf->SysopName
) {
644 $u = User
::newFromName( $conf->getSysopName() );
645 if ( 0 == $u->idForName() ) {
647 $u->setPassword( $conf->getSysopPass() );
650 $u->addGroup( "sysop" );
651 $u->addGroup( "bureaucrat" );
653 print "<li>Created sysop account <tt>" .
654 htmlspecialchars( $conf->SysopName
) . "</tt>.</li>\n";
656 print "<li>Could not create user - already exists!</li>\n";
659 print "<li>Skipped sysop account creation, no name given.</li>\n";
662 $titleobj = Title
::newFromText( wfMsgNoDB( "mainpage" ) );
663 $article = new Article( $titleobj );
664 $newid = $article->insertOn( $wgDatabase );
665 $revision = new Revision( array(
667 'text' => wfMsg( 'mainpagetext' ) . "\n\n" . wfMsg( 'mainpagedocfooter' ),
670 'user_text' => 'MediaWiki default',
672 $revid = $revision->insertOn( $wgDatabase );
673 $article->updateRevisionOn( $wgDatabase, $revision );
676 initialiseMessages();
677 print "</pre></li>\n";
680 /* Write out the config file now that all is well */
681 print "<p>Creating LocalSettings.php...</p>\n\n";
682 $localSettings = "<" . "?php$endl$local$endl?" . ">";
683 // Fix up a common line-ending problem (due to CVS on Windows)
684 $localSettings = str_replace( "\r\n", "\n", $localSettings );
686 if( version_compare( phpversion(), "4.3.2" ) >= 0 ) {
687 $xt = "xt"; # Refuse to overwrite an existing file
689 $xt = "wt"; # 'x' is not available prior to PHP 4.3.2. We did check above, but race conditions blah blah
691 $f = fopen( "LocalSettings.php", $xt );
694 dieout( "<p>Couldn't write out LocalSettings.php. Check that the directory permissions are correct and that there isn't already a file of that name here...</p>\n" .
695 "<p>Here's the file that would have been written, try to paste it into place manually:</p>\n" .
696 "<pre>\n" . htmlspecialchars( $localSettings ) . "</pre>\n" );
698 if(fwrite( $f, $localSettings ) ) {
700 writeSuccessMessage();
703 die("<p class='error'>An error occured while writing the config/LocalSettings.php file. Check user rights and disk space then try again.</p>\n");
715 if( count( $errs ) ) {
716 /* Display options form */
718 if( $conf->posted
) {
719 echo "<p class='error'>Something's not quite right yet; make sure everything below is filled out correctly.</p>\n";
723 <form action
="index.php" name
="config" method
="post">
731 aField( $conf, "Sitename", "Site name:" );
735 Your site name should be a relatively short word
. It
'll appear as the namespace
736 name for 'meta
' pages as well as throughout the user interface. Good site names
737 are things like "<a href="http://www.wikipedia.org/">Wikipedia</a>" and
738 "<a href="http://openfacts.berlios.de/">OpenFacts</a>"; avoid punctuation,
739 which may cause problems.
744 aField( $conf, "EmergencyContact", "Contact e-mail" );
748 This will be used as the return address for password reminders and
749 may be displayed in some error conditions so visitors can get in
750 touch with you. It is also be used as the default sender address of e-mail
751 notifications (enotifs).
755 <label class='column
' for="LanguageCode">Language</label>
756 <select id="LanguageCode" name="LanguageCode">
759 $list = getLanguageList();
760 foreach( $list as $code => $name ) {
761 $sel = ($code == $conf->LanguageCode) ? 'selected
="selected"' : '';
762 echo "\t\t<option value=\"$code\" $sel>$name</option>\n";
768 You may select the language for the user interface of the wiki...
769 Some localizations are less complete than others. Unicode (UTF-8 encoding)
770 is used for all localizations.
774 <label class='column
'>Copyright/license metadata</label>
775 <div>Select one:</div>
778 <li><?php aField( $conf, "License", "no license metadata", "radio", "none" ); ?></li>
779 <li><?php aField( $conf, "License", "GNU Free Documentation License 1.2 (Wikipedia-compatible)", "radio", "gfdl" ); ?></li>
781 aField( $conf, "License", "a Creative Commons license...", "radio", "cc" );
782 $partner = "MediaWiki";
783 $exit = urlencode( "$wgServer{$conf->ScriptPath}/config/index.php?License=cc&RightsUrl=[license_url]&RightsText=[license_name]&RightsCode=[license_code]&RightsIcon=[license_button]" );
784 $icon = urlencode( "$wgServer$wgUploadPath/wiki.png" );
785 $ccApp = htmlspecialchars( "http://creativecommons.org/license/?partner=$partner&exit_url=$exit&partner_icon_url=$icon" );
786 print "<a href=\"$ccApp\">choose</a>";
787 ?> (link will wipe out any other data in this form!)
788 <?php if( $conf->License == "cc" ) { ?>
790 <li><?php aField( $conf, "RightsIcon", "<img src=\"" . htmlspecialchars( $conf->RightsIcon ) . "\" alt='icon
' />", "hidden" ); ?></li>
791 <li><?php aField( $conf, "RightsText", htmlspecialchars( $conf->RightsText ), "hidden" ); ?></li>
792 <li><?php aField( $conf, "RightsCode", "code: " . htmlspecialchars( $conf->RightsCode ), "hidden" ); ?></li>
793 <li><?php aField( $conf, "RightsUrl", "<a href=\"" . htmlspecialchars( $conf->RightsUrl ) . "\">" . htmlspecialchars( $conf->RightsUrl ) . "</a>", "hidden" ); ?></li>
800 MediaWiki can include a basic license notice, icon, and machine-readable
801 copyright metadata if your wiki's content is to be licensed under
802 the GNU FDL
or a Creative Commons license
. If you
're not sure, leave
808 <?php aField( $conf, "SysopName", "Sysop account name:", "" ) ?>
811 <?php aField( $conf, "SysopPass", "password:", "password" ) ?>
814 <?php aField( $conf, "SysopPass2", "again:", "password" ) ?>
817 A sysop user account can lock or delete pages, block problematic IP
818 addresses from editing, and other maintenance tasks. If creating a new
819 wiki database, a sysop account will be created with the given name
824 <label class='column
'>Shared memory caching</label>
825 <div>Select one:</div>
828 <li><?php aField( $conf, "Shm", "no caching", "radio", "none" ); ?></li>
830 if ( $conf->turck ) {
832 aField( $conf, "Shm", "Turck MMCache", "radio", "turck" );
837 if ( $conf->eaccel ) {
839 aField( $conf, "Shm", "eAccelerator", "radio", "eaccel" );
843 <li><?php aField( $conf, "Shm", "Memcached", "radio", "memcached" ); ?></li>
844 <li><?php aField( $conf, "MCServers", "Memcached servers", "" ) ?></li>
848 Using a shared memory system such as Turck MMCache, eAccelerator, or Memcached will speed
849 up MediaWiki significantly. Memcached is the best solution but needs to be
850 installed. Specify the server addresses and ports in a comma-separted list. Only
851 use Turck shared memory if the wiki will be running on a single Apache server.
854 <h2>E-mail, e-mail notification and authentication setup</h2>
858 <label class='column
'>E-mail (general)</label>
859 <div>Select one:</div>
862 <li><?php aField( $conf, "Email", "enabled", "radio", "email_enabled" ); ?></li>
863 <li><?php aField( $conf, "Email", "disabled", "radio", "email_disabled" ); ?></li>
867 Use this to disable all e-mail functions (send a password reminder, user-to-user e-mail and e-mail notification),
868 if sending e-mails on your server doesn't work
.
871 <label
class='column'>User
-to
-user e
-mail
</label
>
872 <div
>Select one
:</div
>
875 <li
><?php
aField( $conf, "Emailuser", "enabled", "radio", "emailuser_enabled" ); ?
></li
>
876 <li
><?php
aField( $conf, "Emailuser", "disabled", "radio", "emailuser_disabled" ); ?
></li
>
880 Use this to disable only the user
-to
-user e
-mail
function (EmailUser
).
883 <label
class='column'>E
-mail notification
</label
>
884 <div
>Select one
:</div
>
887 <li
><?php
aField( $conf, "Enotif", "disabled", "radio", "enotif_disabled" ); ?
></li
>
888 <li
><?php
aField( $conf, "Enotif", "enabled for changes of watch-listed and user_talk pages (recommended for small wikis; perhaps not suited for large wikis)", "radio", "enotif_allpages" ); ?
></li
>
889 <li
><?php
aField( $conf, "Enotif", "enabled for changes of user_talk pages only (suited for small and large wikis)", "radio", "enotif_usertalk" ); ?
></li
>
894 E
-mail notification sends a notification e
-mail to a user
, when the user_talk page is changed
895 and/or when watch
-listed pages are changed
, depending on the above settings
.
896 When testing this feature
, be reminded
, that obviously an e
-mail address must be present in your preferences
897 and that your own changes never trigger notifications to be sent to yourself
.</p
>
899 <p
>Users get corresponding options to select
or deselect in their users
' preferences.
900 The user options are not shown on the preference page, if e-mail notification is disabled.</p>
902 <p>There are additional options for fine tuning in /includes/DefaultSettings.php .</p>
906 <label class='column
'>E-mail address authentication</label>
907 <div>Select one:</div>
910 <li><?php aField( $conf, "Eauthent", "disabled", "radio", "eauthent_disabled" ); ?></li>
911 <li><?php aField( $conf, "Eauthent", "enabled", "radio", "eauthent_enabled" ); ?></li>
915 <p>E-mail address authentication uses a scheme to authenticate e-mail addresses of the users. The user who initially enters or changes his/her stored e-mail address
916 gets a link with a token mailed to that address. The stored e-mail address is authenticated at the moment the user comes back to the wiki via the link.</p>
918 <p>The e-mail address stays authenticated as long as the user does not change it; the time of authentication is indicated
919 on the user preference page.</p>
921 <p>If the option is enabled, only authenticated e-mail addresses can receive EmailUser mails and/or
922 e-mail notification mails.</p>
927 <h2>Database config</h2>
931 <label class='column
'>Database type</label>
932 <div>Select the database server software:</div>
935 aField( $conf, "DBtype", "MySQL", "radio", "mysql");
936 aField( $conf, "DBtype", "Oracle", "radio", "oracle" );
942 aField( $conf, "DBserver", "SQL server host" );
945 If your database server isn't on your web server
, enter the name
946 or IP address here
. MySQL only
.
950 aField( $conf, "DBname", "Database name" );
953 If using Oracle
, set this to your connection identifier
.
956 aField( $conf, "DBuser", "DB username" );
959 aField( $conf, "DBpassword", "DB password", "password" );
962 aField( $conf, "DBpassword2", "again", "password" );
965 If you only have a single user account
and database available
,
966 enter those here
. If you have database root
access (see below
)
967 you can specify
new accounts
/databases to be created
.
971 aField( $conf, "DBprefix", "Database table prefix" );
974 <p
>If you need to share one database between multiple wikis
, or
975 MediaWiki
and another web application
, you may choose to
976 add a prefix to all the table names to avoid conflicts
.</p
>
978 <p
>Avoid exotic characters
; something like
<tt
>mw_
</tt
> is good
.</p
>
983 aField( $conf, "RootPW", "DB root password", "password" );
987 You will only need this
if the database
and/or user account
988 above don
't already exist.
989 Do <em>not</em> type in your machine's root password
! MySQL
990 has its own
"root" user with a separate password
. (It might
991 even be blank
, depending on your configuration
.)
995 <label
class='column'> 
;</label
>
996 <input type
="submit" value
="Install!" />
1006 /* -------------------------------------------------------------------------------------- */
1007 function writeSuccessMessage() {
1009 if ( ini_get( 'safe_mode' ) && !ini_get( 'open_basedir' ) ) {
1011 <p>Installation successful!</p>
1012 <p>To complete the installation, please do the following:
1014 <li>Download config/LocalSettings.php with your FTP client or file manager</li>
1015 <li>Upload it to the parent directory</li>
1016 <li>Delete config/LocalSettings.php</li>
1017 <li>Start using <a href='../index.php'>your wiki</a>!
1019 <p>If you are in a shared hosting environment, do <strong>not</strong> just move LocalSettings.php
1020 remotely. LocalSettings.php is currently owned by the user your webserver is running under,
1021 which means that anyone on the same server can read your database password! Downloading
1022 it and uploading it again will hopefully change the ownership to a user ID specific to you.</p>
1025 echo "<p>Installation successful! Move the config/LocalSettings.php file into the parent directory, then follow
1026 <a href='../index.php'>this link</a> to your wiki.</p>\n";
1031 function escapePhpString( $string ) {
1032 return strtr( $string,
1043 function writeLocalSettings( $conf ) {
1044 $conf->UseImageResize
= $conf->UseImageResize ?
'true' : 'false';
1045 $conf->PasswordSender
= $conf->EmergencyContact
;
1046 $zlib = ($conf->zlib ?
"" : "# ");
1047 $magic = ($conf->ImageMagick ?
"" : "# ");
1048 $convert = ($conf->ImageMagick ?
$conf->ImageMagick
: "/usr/bin/convert" );
1049 $pretty = ($conf->prettyURLs ?
"" : "# ");
1050 $ugly = ($conf->prettyURLs ?
"# " : "");
1051 $rights = ($conf->RightsUrl
) ?
"" : "# ";
1052 $hashedUploads = $conf->safeMode ?
'' : '# ';
1054 switch ( $conf->Shm
) {
1056 $cacheType = 'CACHE_MEMCACHED';
1057 $mcservers = var_export( $conf->MCServerArray
, true );
1061 $cacheType = 'CACHE_ACCEL';
1062 $mcservers = 'array()';
1065 $cacheType = 'CACHE_NONE';
1066 $mcservers = 'array()';
1069 if ( $conf->Email
== 'email_enabled' ) {
1070 $enableemail = 'true';
1071 $enableuseremail = ( $conf->Emailuser
== 'emailuser_enabled' ) ?
'true' : 'false' ;
1072 $eauthent = ( $conf->Eauthent
== 'eauthent_enabled' ) ?
'true' : 'false' ;
1073 switch ( $conf->Enotif
) {
1074 case 'enotif_usertalk':
1075 $enotifusertalk = 'true';
1076 $enotifwatchlist = 'false';
1078 case 'enotif_allpages':
1079 $enotifusertalk = 'true';
1080 $enotifwatchlist = 'true';
1083 $enotifusertalk = 'false';
1084 $enotifwatchlist = 'false';
1087 $enableuseremail = 'false';
1088 $enableemail = 'false';
1089 $eauthent = 'false';
1090 $enotifusertalk = 'false';
1091 $enotifwatchlist = 'false';
1094 $file = @fopen
( "/dev/urandom", "r" );
1096 $secretKey = bin2hex( fread( $file, 32 ) );
1100 for ( $i=0; $i<8; $i++
) {
1101 $secretKey .= dechex(mt_rand(0, 0x7fffffff));
1103 print "<li>Warning: \$wgSecretKey key is insecure, generated with mt_rand(). Consider changing it manually.</li>\n";
1106 # Add slashes to strings for double quoting
1107 $slconf = array_map( "escapePhpString", get_object_vars( $conf ) );
1108 if( $conf->License
== 'gfdl' ) {
1109 # Needs literal string interpolation for the current style path
1110 $slconf['RightsIcon'] = $conf->RightsIcon
;
1113 $sep = (DIRECTORY_SEPARATOR
== "\\") ?
";" : ":";
1115 # This file was automatically generated by the MediaWiki installer.
1116 # If you make manual changes, please keep track in case you need to
1117 # recreate them later.
1119 # See includes/DefaultSettings.php for all configurable settings
1120 # and their default values, but don't forget to make changes in _this_
1123 \$IP = \"{$slconf['IP']}\";
1124 ini_set( \"include_path\", \".$sep\$IP$sep\$IP/includes$sep\$IP/languages\" );
1125 require_once( \"includes/DefaultSettings.php\" );
1127 # If PHP's memory limit is very low, some operations may fail.
1128 " . ($conf->raiseMemory ?
'' : '# ' ) . "ini_set( 'memory_limit', '20M' );" . "
1130 if ( \$wgCommandLineMode ) {
1131 if ( isset( \$_SERVER ) && array_key_exists( 'REQUEST_METHOD', \$_SERVER ) ) {
1132 die( \"This script must be run from the command line\\n\" );
1134 } elseif ( empty( \$wgNoOutputBuffer ) ) {
1135 ## Compress output if the browser supports it
1136 {$zlib}if( !ini_get( 'zlib.output_compression' ) ) @ob_start( 'ob_gzhandler' );
1139 \$wgSitename = \"{$slconf['Sitename']}\";
1141 \$wgScriptPath = \"{$slconf['ScriptPath']}\";
1142 \$wgScript = \"\$wgScriptPath/index.php\";
1143 \$wgRedirectScript = \"\$wgScriptPath/redirect.php\";
1145 ## If using PHP as a CGI module, use the ugly URLs
1146 {$pretty}\$wgArticlePath = \"\$wgScript/\$1\";
1147 {$ugly}\$wgArticlePath = \"\$wgScript?title=\$1\";
1149 \$wgStylePath = \"\$wgScriptPath/skins\";
1150 \$wgStyleDirectory = \"\$IP/skins\";
1151 \$wgLogo = \"\$wgStylePath/common/images/wiki.png\";
1153 \$wgUploadPath = \"\$wgScriptPath/images\";
1154 \$wgUploadDirectory = \"\$IP/images\";
1156 \$wgEnableEmail = $enableemail;
1157 \$wgEnableUserEmail = $enableuseremail;
1159 \$wgEmergencyContact = \"{$slconf['EmergencyContact']}\";
1160 \$wgPasswordSender = \"{$slconf['PasswordSender']}\";
1162 ## For a detailed description of the following switches see
1163 ## http://meta.wikimedia.org/Enotif and http://meta.wikimedia.org/Eauthent
1164 ## There are many more options for fine tuning available see
1165 ## /includes/DefaultSettings.php
1166 ## UPO means: this is also a user preference option
1167 \$wgEnotifUserTalk = $enotifusertalk; # UPO
1168 \$wgEnotifWatchlist = $enotifwatchlist; # UPO
1169 \$wgEmailAuthentication = $eauthent;
1171 \$wgDBserver = \"{$slconf['DBserver']}\";
1172 \$wgDBname = \"{$slconf['DBname']}\";
1173 \$wgDBuser = \"{$slconf['DBuser']}\";
1174 \$wgDBpassword = \"{$slconf['DBpassword']}\";
1175 \$wgDBprefix = \"{$slconf['DBprefix']}\";
1176 \$wgDBtype = \"{$slconf['DBtype']}\";
1178 ## Shared memory settings
1179 \$wgMainCacheType = $cacheType;
1180 \$wgMemCachedServers = $mcservers;
1182 ## To enable image uploads, make sure the 'images' directory
1183 ## is writable, then uncomment this:
1184 # \$wgEnableUploads = true;
1185 \$wgUseImageResize = {$conf->UseImageResize};
1186 {$magic}\$wgUseImageMagick = true;
1187 {$magic}\$wgImageMagickConvertCommand = \"{$convert}\";
1189 ## If you want to use image uploads under safe mode,
1190 ## create the directories images/archive, images/thumb and
1191 ## images/temp, and make them all writable. Then uncomment
1192 ## this, if it's not already uncommented:
1193 {$hashedUploads}\$wgHashedUploadDirectory = false;
1195 ## If you have the appropriate support software installed
1196 ## you can enable inline LaTeX equations:
1197 # \$wgUseTeX = true;
1198 \$wgMathPath = \"{\$wgUploadPath}/math\";
1199 \$wgMathDirectory = \"{\$wgUploadDirectory}/math\";
1200 \$wgTmpDirectory = \"{\$wgUploadDirectory}/tmp\";
1202 \$wgLocalInterwiki = \$wgSitename;
1204 \$wgLanguageCode = \"{$slconf['LanguageCode']}\";
1206 \$wgProxyKey = \"$secretKey\";
1208 ## Default skin: you can change the default skin. Use the internal symbolic
1209 ## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook':
1210 # \$wgDefaultSkin = 'monobook';
1212 ## For attaching licensing metadata to pages, and displaying an
1213 ## appropriate copyright notice / icon. GNU Free Documentation
1214 ## License and Creative Commons licenses are supported so far.
1215 {$rights}\$wgEnableCreativeCommonsRdf = true;
1216 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
1217 \$wgRightsUrl = \"{$slconf['RightsUrl']}\";
1218 \$wgRightsText = \"{$slconf['RightsText']}\";
1219 \$wgRightsIcon = \"{$slconf['RightsIcon']}\";
1220 # \$wgRightsCode = \"{$slconf['RightsCode']}\"; # Not yet used
1222 \$wgDiff3 = \"{$slconf['diff3']}\";
1224 // Keep things in Unix line endings internally;
1225 // the system will write out as local text type.
1226 return str_replace( "\r\n", "\n", $localsettings );
1229 function dieout( $text ) {
1230 die( $text . "\n\n</body>\n</html>" );
1233 function importVar( &$var, $name, $default = "" ) {
1234 if( isset( $var[$name] ) ) {
1235 $retval = $var[$name];
1236 if ( get_magic_quotes_gpc() ) {
1237 $retval = stripslashes( $retval );
1245 function importPost( $name, $default = "" ) {
1246 return importVar( $_POST, $name, $default );
1249 function importRequest( $name, $default = "" ) {
1250 return importVar( $_REQUEST, $name, $default );
1253 function aField( &$conf, $field, $text, $type = "", $value = "" ) {
1255 $xtype = "type=\"$type\"";
1260 if(!(isset($id)) or ($id == "") ) $id = $field;
1261 $nolabel = ($type == "radio") ||
($type == "hidden");
1265 echo "\t\t<label class='column' for=\"$id\">$text</label>\n";
1268 if( $type == "radio" && $value == $conf->$field ) {
1269 $checked = "checked='checked'";
1273 echo "\t\t<input $xtype name=\"$field\" id=\"$id\" $checked value=\"";
1274 if( $type == "radio" ) {
1275 echo htmlspecialchars( $value );
1277 echo htmlspecialchars( $conf->$field );
1281 echo " $text</label>\n";
1285 if(isset($errs[$field])) echo "<span class='error'>" . $errs[$field] . "</span>\n";
1288 function getLanguageList() {
1289 global $wgLanguageNames;
1290 if( !isset( $wgLanguageNames ) ) {
1291 $wgContLanguageCode = "xxx";
1292 function wfLocalUrl( $x ) { return $x; }
1293 function wfLocalUrlE( $x ) { return $x; }
1294 require_once( "languages/Names.php" );
1299 $d = opendir( "../languages" );
1300 while( false !== ($f = readdir( $d ) ) ) {
1301 if( preg_match( '/Language([A-Z][a-z_]+)\.php$/', $f, $m ) ) {
1302 $code = str_replace( '_', '-', strtolower( $m[1] ) );
1303 if( isset( $wgLanguageNames[$code] ) ) {
1304 $name = $code . ' - ' . $wgLanguageNames[$code];
1308 $codes[$code] = $name;
1316 #Check for location of an executable
1317 # @param string $loc single location to check
1318 # @param array $names filenames to check for.
1319 # @param mixed $versioninfo array of details to use when checking version, use false for no version checking
1320 function locate_executable($loc, $names, $versioninfo = false) {
1321 if (!is_array($names))
1322 $names = array($names);
1324 foreach ($names as $name) {
1325 if (file_exists("$loc/$name")) {
1327 return "$loc/$name";
1329 $file = str_replace('$1', "$loc/$name", $versioninfo[0]);
1330 if (strstr(`
$file`
, $versioninfo[1]) !== false)
1331 return "$loc/$name";
1337 function get_db_version() {
1338 global $wgDatabase, $conf;
1339 if ($conf->DBtype
== 'mysql')
1340 return mysql_get_server_info( $wgDatabase->mConn
);
1341 else if ($conf->DBtype
== 'oracle')
1342 return oci_server_version($wgDatabase->mConn
);
1345 # Test a memcached server
1346 function testMemcachedServer( $server ) {
1347 $hostport = explode(":", $server);
1350 if ( !function_exists( 'fsockopen' ) ) {
1351 $errstr = "Can't connect to memcached, fsockopen() not present";
1353 if ( !$errstr && count( $hostport ) != 2 ) {
1354 $errstr = 'Please specify host and port';
1355 var_dump( $hostport );
1358 list( $host, $port ) = $hostport;
1362 $fp = @fsockopen
( $host, $port, $errno, $fsockerr, 1.0 );
1363 if ( $fp === false ) {
1364 $errstr = "Cannot connect to memcached on $host:$port : $fsockerr";
1368 $command = "version\r\n";
1369 $bytes = fwrite( $fp, $command );
1370 if ( $bytes != strlen( $command ) ) {
1371 $errstr = "Cannot write to memcached socket on $host:$port";
1375 $expected = "VERSION ";
1376 $response = fread( $fp, strlen( $expected ) );
1377 if ( $response != $expected ) {
1378 $errstr = "Didn't get correct memcached response from $host:$port";
1385 echo "<li>Connected to memcached on $host:$port successfully";